<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>DTDResolver xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/torque/engine/database/transform/DTDResolver.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <strong>package</strong> <a href="../../../../../../org/apache/torque/engine/database/transform/package-summary.html">org.apache.torque.engine.database.transform</a>;
<a name="2" href="#2">2</a>   
<a name="3" href="#3">3</a>   <em class="comment">/*</em>
<a name="4" href="#4">4</a>   <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="5" href="#5">5</a>   <em class="comment"> * or more contributor license agreements.  See the NOTICE file</em>
<a name="6" href="#6">6</a>   <em class="comment"> * distributed with this work for additional information</em>
<a name="7" href="#7">7</a>   <em class="comment"> * regarding copyright ownership.  The ASF licenses this file</em>
<a name="8" href="#8">8</a>   <em class="comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="9" href="#9">9</a>   <em class="comment"> * "License"); you may not use this file except in compliance</em>
<a name="10" href="#10">10</a>  <em class="comment"> * with the License.  You may obtain a copy of the License at</em>
<a name="11" href="#11">11</a>  <em class="comment"> *</em>
<a name="12" href="#12">12</a>  <em class="comment"> *   <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="13" href="#13">13</a>  <em class="comment"> *</em>
<a name="14" href="#14">14</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="15" href="#15">15</a>  <em class="comment"> * software distributed under the License is distributed on an</em>
<a name="16" href="#16">16</a>  <em class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="17" href="#17">17</a>  <em class="comment"> * KIND, either express or implied.  See the License for the</em>
<a name="18" href="#18">18</a>  <em class="comment"> * specific language governing permissions and limitations</em>
<a name="19" href="#19">19</a>  <em class="comment"> * under the License.</em>
<a name="20" href="#20">20</a>  <em class="comment"> */</em>
<a name="21" href="#21">21</a>  
<a name="22" href="#22">22</a>  <strong>import</strong> java.io.IOException;
<a name="23" href="#23">23</a>  <strong>import</strong> java.io.InputStream;
<a name="24" href="#24">24</a>  
<a name="25" href="#25">25</a>  <strong>import</strong> org.apache.commons.logging.Log;
<a name="26" href="#26">26</a>  <strong>import</strong> org.apache.commons.logging.LogFactory;
<a name="27" href="#27">27</a>  <strong>import</strong> org.xml.sax.EntityResolver;
<a name="28" href="#28">28</a>  <strong>import</strong> org.xml.sax.InputSource;
<a name="29" href="#29">29</a>  <strong>import</strong> org.xml.sax.SAXException;
<a name="30" href="#30">30</a>  
<a name="31" href="#31">31</a>  <em>/**<em>*</em></em>
<a name="32" href="#32">32</a>  <em> * A resolver to get the database.dtd file for the XML parser from the jar.</em>
<a name="33" href="#33">33</a>  <em> *</em>
<a name="34" href="#34">34</a>  <em> * @author &lt;a href="<a href="mailto:mpoeschl@marmot.at" target="alexandria_uri">mailto:mpoeschl@marmot.at</a>">Martin Poeschl&lt;/a></em>
<a name="35" href="#35">35</a>  <em> * @author &lt;a href="<a href="mailto:kschrader@karmalab.org" target="alexandria_uri">mailto:kschrader@karmalab.org</a>">Kurt Schrader&lt;/a></em>
<a name="36" href="#36">36</a>  <em> * @author &lt;a href="<a href="mailto:quintonm@bellsouth.net" target="alexandria_uri">mailto:quintonm@bellsouth.net</a>">Quinton McCombs&lt;/a></em>
<a name="37" href="#37">37</a>  <em> * @version $Id: DTDResolver.java 491216 2006-12-30 12:14:45Z tfischer $</em>
<a name="38" href="#38">38</a>  <em> */</em>
<a name="39" href="#39">39</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../../../org/apache/torque/engine/database/transform/DTDResolver.html">DTDResolver</a> implements EntityResolver
<a name="40" href="#40">40</a>  {
<a name="41" href="#41">41</a>      <em>/**<em>* Where the DTD is located on the web. */</em></em>
<a name="42" href="#42">42</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> String WEB_SITE_DTD
<a name="43" href="#43">43</a>              = <span class="string">"http://db.apache.org/torque/dtd/database_3_3.dtd"</span>;
<a name="44" href="#44">44</a>  
<a name="45" href="#45">45</a>      <em>/**<em>* Where the 3.2 DTD is located on the web. */</em></em>
<a name="46" href="#46">46</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> String WEB_SITE_DTD_3_2
<a name="47" href="#47">47</a>              = <span class="string">"http://db.apache.org/torque/dtd/database_3_2.dtd"</span>;
<a name="48" href="#48">48</a>  
<a name="49" href="#49">49</a>      <em>/**<em>* Logging class from commons.logging */</em></em>
<a name="50" href="#50">50</a>      <strong>private</strong> <strong>static</strong> Log log = LogFactory.getLog(DTDResolver.<strong>class</strong>);
<a name="51" href="#51">51</a>  
<a name="52" href="#52">52</a>      <em>/**<em>*</em></em>
<a name="53" href="#53">53</a>  <em>     * constructor</em>
<a name="54" href="#54">54</a>  <em>     */</em>
<a name="55" href="#55">55</a>      <strong>public</strong> <a href="../../../../../../org/apache/torque/engine/database/transform/DTDResolver.html">DTDResolver</a>()
<a name="56" href="#56">56</a>              throws SAXException
<a name="57" href="#57">57</a>      {
<a name="58" href="#58">58</a>      }
<a name="59" href="#59">59</a>  
<a name="60" href="#60">60</a>      <em>/**<em>*</em></em>
<a name="61" href="#61">61</a>  <em>     * An implementation of the SAX &lt;code>EntityResolver&lt;/code></em>
<a name="62" href="#62">62</a>  <em>     * interface to be called by the XML parser.  If the dtd is the</em>
<a name="63" href="#63">63</a>  <em>     * current Torque DTD, the DTD is read from the generator jar.</em>
<a name="64" href="#64">64</a>  <em>     * In all other cases, null is returned to indicate that the parser</em>
<a name="65" href="#65">65</a>  <em>     * should open a regular connection to the systemId URI.</em>
<a name="66" href="#66">66</a>  <em>     *</em>
<a name="67" href="#67">67</a>  <em>     * @param publicId The public identifier of the external entity</em>
<a name="68" href="#68">68</a>  <em>     * @param systemId The system identifier of the external entity</em>
<a name="69" href="#69">69</a>  <em>     * @return An &lt;code>InputSource&lt;/code> for the</em>
<a name="70" href="#70">70</a>  <em>     * &lt;code>database.dtd&lt;/code> file in the generator jar, or null.</em>
<a name="71" href="#71">71</a>  <em>     */</em>
<a name="72" href="#72">72</a>      <strong>public</strong> InputSource resolveEntity(String <strong>public</strong>Id, String systemId)
<a name="73" href="#73">73</a>              throws IOException, SAXException
<a name="74" href="#74">74</a>      {
<a name="75" href="#75">75</a>          <strong>if</strong> (WEB_SITE_DTD.equals(systemId))
<a name="76" href="#76">76</a>          {
<a name="77" href="#77">77</a>              <strong>return</strong> readFromClasspath(<span class="string">"database.dtd"</span>);
<a name="78" href="#78">78</a>          }
<a name="79" href="#79">79</a>          <strong>else</strong> <strong>if</strong> (WEB_SITE_DTD_3_2.equals(systemId))
<a name="80" href="#80">80</a>          {
<a name="81" href="#81">81</a>              <strong>return</strong> readFromClasspath(<span class="string">"database_3_2.dtd"</span>);
<a name="82" href="#82">82</a>          }
<a name="83" href="#83">83</a>          <strong>else</strong>
<a name="84" href="#84">84</a>          {
<a name="85" href="#85">85</a>              log.debug(<span class="string">"Resolver: used default behaviour"</span>);
<a name="86" href="#86">86</a>              <strong>return</strong> <strong>null</strong>;
<a name="87" href="#87">87</a>          }
<a name="88" href="#88">88</a>      }
<a name="89" href="#89">89</a>  
<a name="90" href="#90">90</a>      <em>/**<em>*</em></em>
<a name="91" href="#91">91</a>  <em>     * Reads the resource with the given name from the classpath.</em>
<a name="92" href="#92">92</a>  <em>     *</em>
<a name="93" href="#93">93</a>  <em>     * @param resourceName the name of the resource to read</em>
<a name="94" href="#94">94</a>  <em>     * @return an Inputsource witht the content of the resource.</em>
<a name="95" href="#95">95</a>  <em>     *</em>
<a name="96" href="#96">96</a>  <em>     * @throws SAXException if the resource cannot be read.</em>
<a name="97" href="#97">97</a>  <em>     */</em>
<a name="98" href="#98">98</a>      <strong>private</strong> InputSource readFromClasspath(String resourceName)
<a name="99" href="#99">99</a>          throws SAXException
<a name="100" href="#100">100</a>     {
<a name="101" href="#101">101</a>         <strong>try</strong>
<a name="102" href="#102">102</a>         {
<a name="103" href="#103">103</a>             InputStream dtdStream
<a name="104" href="#104">104</a>                     = getClass().getResourceAsStream(resourceName);
<a name="105" href="#105">105</a> 
<a name="106" href="#106">106</a>             <em class="comment">// getResource was buggy on many systems including Linux,</em>
<a name="107" href="#107">107</a>             <em class="comment">// OSX, and some versions of windows in jdk1.3.</em>
<a name="108" href="#108">108</a>             <em class="comment">// getResourceAsStream works on linux, maybe others?</em>
<a name="109" href="#109">109</a>             <strong>if</strong> (dtdStream != <strong>null</strong>)
<a name="110" href="#110">110</a>             {
<a name="111" href="#111">111</a>                 String pkg = getClass().getName().substring(0,
<a name="112" href="#112">112</a>                         getClass().getName().lastIndexOf('.'));
<a name="113" href="#113">113</a>                 log.debug(<span class="string">"Resolver: used "</span> + resourceName + <span class="string">" from '"</span>
<a name="114" href="#114">114</a>                          + pkg + <span class="string">"' package"</span>);
<a name="115" href="#115">115</a>                 <strong>return</strong> <strong>new</strong> InputSource(dtdStream);
<a name="116" href="#116">116</a>             }
<a name="117" href="#117">117</a>             <strong>else</strong>
<a name="118" href="#118">118</a>             {
<a name="119" href="#119">119</a>                 log.warn(<span class="string">"Could not locate database.dtd"</span>);
<a name="120" href="#120">120</a>                 <strong>return</strong> <strong>null</strong>;
<a name="121" href="#121">121</a>             }
<a name="122" href="#122">122</a>         }
<a name="123" href="#123">123</a>         <strong>catch</strong> (Exception ex)
<a name="124" href="#124">124</a>         {
<a name="125" href="#125">125</a>             <strong>throw</strong> <strong>new</strong> SAXException(
<a name="126" href="#126">126</a>                     <span class="string">"Could not get stream for "</span> + resourceName,
<a name="127" href="#127">127</a>                     ex);
<a name="128" href="#128">128</a>         }
<a name="129" href="#129">129</a>     }
<a name="130" href="#130">130</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

